<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketserver;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.codemonkey.util.Executable;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    /**<a name="line.5"></a>
<FONT color="green">006</FONT>     * Defines a base for decodable and executable message types. This class also keeps a reference to the current {@link ClientContext} that<a name="line.6"></a>
<FONT color="green">007</FONT>     * sent the message.<a name="line.7"></a>
<FONT color="green">008</FONT>     * &lt;p&gt;<a name="line.8"></a>
<FONT color="green">009</FONT>     * With this base class, a message can decode a &lt;code&gt;String&lt;/code&gt; to fill itself. This interface is used to translate so called &lt;a<a name="line.9"></a>
<FONT color="green">010</FONT>     * href="http://gpwiki.org/index.php/Binary_Packet"&gt;Binary Packets&lt;/a&gt;, or datagrams, into {@link Executable} messages. This means an<a name="line.10"></a>
<FONT color="green">011</FONT>     * instance of {@link ClientMessageToServer} is very much a command-like object.<a name="line.11"></a>
<FONT color="green">012</FONT>     * &lt;p&gt;<a name="line.12"></a>
<FONT color="green">013</FONT>     * A response string needs to built up in the following format:&lt;br /&gt;<a name="line.13"></a>
<FONT color="green">014</FONT>     * message id (3), encoded string<a name="line.14"></a>
<FONT color="green">015</FONT>     * &lt;p&gt;<a name="line.15"></a>
<FONT color="green">016</FONT>     * The following example could of a login response: &lt;code&gt;0035admin7letmein&lt;/code&gt;&lt;br /&gt;<a name="line.16"></a>
<FONT color="green">017</FONT>     * The following example could of a pong notification: &lt;code&gt;{@value SwiftSocketServer#MESSAGE_ID_PINGPONG}&lt;/code&gt;&lt;br /&gt;<a name="line.17"></a>
<FONT color="green">018</FONT>     * &lt;p&gt;<a name="line.18"></a>
<FONT color="green">019</FONT>     * It is up to the implementing class to decode this information and utilize it as an executable object.<a name="line.19"></a>
<FONT color="green">020</FONT>     * &lt;p&gt;<a name="line.20"></a>
<FONT color="green">021</FONT>     * <a name="line.21"></a>
<FONT color="green">022</FONT>     * @author Benny Bottema<a name="line.22"></a>
<FONT color="green">023</FONT>     * @param &lt;Controller&gt; The type to which the executable can defer to (also see {@link Executable#execute(Object)}).<a name="line.23"></a>
<FONT color="green">024</FONT>     * @see Executable The interface used by the server to execute the client message after it has been decoded.<a name="line.24"></a>
<FONT color="green">025</FONT>     * @see SwiftSocketServer#addClientMessage(ClientMessageToServer)<a name="line.25"></a>
<FONT color="green">026</FONT>     * @see SwiftSocketServer#getNextClientMessage()<a name="line.26"></a>
<FONT color="green">027</FONT>     * @since 1.0<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public abstract class ClientMessageToServer&lt;Controller&gt; implements Executable&lt;Controller, UnknownMessageException&gt; {<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>            /**<a name="line.31"></a>
<FONT color="green">032</FONT>             * Holds the information about the whereabouts of the connected client that was responsible for the current message.<a name="line.32"></a>
<FONT color="green">033</FONT>             */<a name="line.33"></a>
<FONT color="green">034</FONT>            private final ClientContext clientContext;<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>            /**<a name="line.36"></a>
<FONT color="green">037</FONT>             * Constructor; simply stores a reference to the client associated with this message.<a name="line.37"></a>
<FONT color="green">038</FONT>             * <a name="line.38"></a>
<FONT color="green">039</FONT>             * @param clientContext The client associated with this message.<a name="line.39"></a>
<FONT color="green">040</FONT>             */<a name="line.40"></a>
<FONT color="green">041</FONT>            protected ClientMessageToServer(final ClientContext clientContext) {<a name="line.41"></a>
<FONT color="green">042</FONT>                    this.clientContext = clientContext;<a name="line.42"></a>
<FONT color="green">043</FONT>            }<a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>            /**<a name="line.45"></a>
<FONT color="green">046</FONT>             * @return The id of the client associated with this message (more important for responding to client messages).<a name="line.46"></a>
<FONT color="green">047</FONT>             */<a name="line.47"></a>
<FONT color="green">048</FONT>            protected final ClientContext getClientContext() {<a name="line.48"></a>
<FONT color="green">049</FONT>                    return clientContext;<a name="line.49"></a>
<FONT color="green">050</FONT>            }<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>            /**<a name="line.52"></a>
<FONT color="green">053</FONT>             * Translates a message string or binary packet to the contents of the current {@link ClientMessageToServer} object, ready to be<a name="line.53"></a>
<FONT color="green">054</FONT>             * executed.<a name="line.54"></a>
<FONT color="green">055</FONT>             * <a name="line.55"></a>
<FONT color="green">056</FONT>             * @param datagramMessage The binary packet that contains information specific for the current {@link ClientMessageToServer}.<a name="line.56"></a>
<FONT color="green">057</FONT>             */<a name="line.57"></a>
<FONT color="green">058</FONT>            protected abstract void decode(final String datagramMessage);<a name="line.58"></a>
<FONT color="green">059</FONT>    }<a name="line.59"></a>




























































</PRE>
</BODY>
</HTML>
